Esx Hosts ImageSelectionInfo

The Esx Hosts ImageSelectionInfo schema contains properties to describe the selection criteria used to select an image for 1 or more hosts

This schema was added in vSphere API 9.0.0.0.

JSON Example

{
    "selection_type": "string",
    "host_uuids": [
        "string"
    ],
    "host_hardware_spec": {
        "vendor": "string",
        "models": [
            "string"
        ],
        "families": [
            "string"
        ],
        "oem_strings": [
            "string"
        ]
    }
}

string

selection_type

Required

Specifies what type of selection (SelectionType) is to be used for selecting an image for a host. HOST_UUID is intended to be used when an image needs to be selected for a host based on the host's uuid. Maps to "UUID" in SMBIOS: System Information (Type 1) and offset 08h HOST_HARDWARE_SPEC is intended to be used when an image needs to be selected for 1 or more hosts based on the host's hardware specifications like vendor, model, family and oem string.

For more information see: Esx Hosts ImageSelectionInfo SelectionType.

This property was added in vSphere API 9.0.0.0.

array of string

host_uuids

Optional

Specifies the host's uuid for which an image needs to be selected. Maps to "UUID" in SMBIOS: System Information (Type 1) and offset 08h

This property was added in vSphere API 9.0.0.0.

This property is optional and it is only relevant when the value of selection_type is Esx Hosts ImageSelectionInfo SelectionType.HOST_UUID.

host_hardware_spec

Optional

Specifies the host's hardware specification like vendor, model, family and oem string for which an image needs to be selected.

Selection logic will be AND operation across the attributes and OR operation within an attribute

Ex: For vendor = "OEM 1" model = ["Model Gen9", "Model Gen10"] family = ["Family 1", "Family 2"] oemString = ["OEM String 1", "OEM String 2"]

Logic will be "OEM 1" AND ("Model Gen9" OR "Model Gen10") AND ("Family 1" OR "Family 2") AND ("OEM String 1" OR "OEM String 2")

This property was added in vSphere API 9.0.0.0.

This property is optional and it is only relevant when the value of selection_type is Esx Hosts ImageSelectionInfo SelectionType.HOST_HARDWARE_SPEC.